Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: adds documentations for the new management api #441

Closed
wants to merge 13 commits into from
Closed

docs: adds documentations for the new management api #441

wants to merge 13 commits into from

Conversation

yurimssilva
Copy link
Contributor

WHAT

  • Adds initial documentation for the new management API.

saschaisele-zf
saschaisele-zf suggested changes Jun 1, 2023
View reviewed changes
docs/samples/management-api-v2-walkthrough/1-management-api-oveview.md Show resolved Hide resolved
docs/samples/management-api-v2-walkthrough/1-management-api-oveview.md Outdated Show resolved Hide resolved
docs/samples/management-api-v2-walkthrough/1-management-api-oveview.md Outdated Show resolved Hide resolved
docs/samples/management-api-v2-walkthrough/2-assets.md Show resolved Hide resolved
docs/samples/management-api-v2-walkthrough/3-policy-definitions.md Outdated Show resolved Hide resolved
docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md Outdated Show resolved Hide resolved
docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md Outdated Show resolved Hide resolved
docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md Outdated Show resolved Hide resolved
@saschaisele-zf
Copy link
Contributor

Could you also take a look? @ndr-brt @paullatzelsperger

@florianrusch-zf
Copy link
Contributor

florianrusch-zf commented Jun 12, 2023 •
edited
Loading

@yurimssilva I just approved and run the GitHub checks for this PR. Please have a look at the failed checks :-)

@saschaisele-zf
Copy link
Contributor

@stephanbcbauer review needed :)

@saschaisele-zf saschaisele-zf added the documentation Improvements or additions to documentation label Jun 14, 2023
stephanbcbauer
stephanbcbauer approved these changes Jun 19, 2023
View reviewed changes
Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but i am still not sure if the documentation should be here or at upstream :)

ndr-brt
ndr-brt approved these changes Jun 20, 2023
View reviewed changes
Copy link
Contributor

@ndr-brt ndr-brt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These definitively deserve to stay on upstream

florianrusch-zf
florianrusch-zf reviewed Jun 22, 2023
View reviewed changes
docs/samples/management-api-v2-walkthrough/2-assets.md Outdated
Comment on lines 28 to 50
{
"@context": {
"@vocab": "https://w3id.org/edc/v0.0.1/ns/"
},
"@type": "AssetEntryDto",
"asset": {
"@id": "asset-id",
"properties": {
"name": "asset-name",
"description": "asset-description",
"version": "0.0.1",
"contenttype": "application/json"
},
"privateProperties": {
"pvt-prop-1": "prt-prov-val-1",
"pvt-prop-2": "prt-prov-val-2"
}
},
"dataAddress": {
"type": "asset-address-type",
"keyName": "asset-key-name"
}
}
Copy link
Contributor

@florianrusch-zf florianrusch-zf Jun 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This object doesn't match with the object thats in our Postman collection. Have you tried to put this objects to an real EDC? Could you double check it?

We (ZF) tried to create assets based on your structure and received a 500. Sadly I can't provide the error message any longer :-/

\cc @tuncaytunc-zf

Copy link
Contributor

@florianrusch-zf florianrusch-zf Jun 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Object in the postman collections looks like this:

{
    "@context": {},
    "asset": {
        "@type": "Asset",
        "@id": "{{ASSET_ID}}",
        "properties": {
            "description": "Product EDC Demo Asset"
        }
    },
    "dataAddress": {
        "@type": "DataAddress",
        "type": "HttpData",
        "baseUrl": "https://jsonplaceholder.typicode.com/todos"
    }
}

Copy link
Contributor Author

@yurimssilva yurimssilva Jun 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tried it, and it works. The only thing "wrong" there is the dataAddress.type, where I put a placeholder that doesn't look like one, and I'll change it.

@sonarcloud
Copy link

sonarcloud bot commented Jun 26, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@saschaisele-zf
Copy link
Contributor

This PR should be closed here and moved to the upstream edc repository.

@sonarcloud
Copy link

sonarcloud bot commented Jul 10, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@yurimssilva
Copy link
Contributor Author

PR moved upstream.

@stephanbcbauer
Copy link
Member

@yurimssilva please let me know when the PR on upstream is ready. Because I also want to update the documentation on tractusx.github.io

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ndr-brt ndr-brt ndr-brt approved these changes

@stephanbcbauer stephanbcbauer stephanbcbauer approved these changes

@saschaisele-zf saschaisele-zf saschaisele-zf approved these changes

@DrDanielMetz DrDanielMetz Awaiting requested review from DrDanielMetz

@paullatzelsperger paullatzelsperger Awaiting requested review from paullatzelsperger

@florianrusch-zf florianrusch-zf Awaiting requested review from florianrusch-zf

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
EDC PR Board
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@yurimssilva @saschaisele-zf @florianrusch-zf @stephanbcbauer @ndr-brt @paullatzelsperger @DrDanielMetz